<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BonoboMonikerSimple</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Libbonobo Reference Manual">
<link rel="up" href="monikers.html" title="Monikers">
<link rel="prev" href="libbonobo-bonobo-moniker.html" title="BonoboMoniker">
<link rel="next" href="libbonobo-bonobo-moniker-util.html" title="bonobo-moniker-util">
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libbonobo-bonobo-moniker.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="monikers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libbonobo Reference Manual</th>
<td><a accesskey="n" href="libbonobo-bonobo-moniker-util.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libbonobo-bonobo-moniker-simple.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libbonobo-bonobo-moniker-simple.description" class="shortcut">Description</a>
                   | 
                  <a href="#libbonobo-bonobo-moniker-simple.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbonobo-bonobo-moniker-simple"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonobo-bonobo-moniker-simple.top_of_page"></a>BonoboMonikerSimple</span></h2>
<p>BonoboMonikerSimple — A super easy to use moniker implementation wrapper</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbonobo-bonobo-moniker-simple.synopsis"></a><h2>Synopsis</h2>
<a name="BonoboMonikerSimple"></a><pre class="synopsis">                    <a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple-struct" title="BonoboMonikerSimple">BonoboMonikerSimple</a>;
                    <a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimpleClass" title="BonoboMonikerSimpleClass">BonoboMonikerSimpleClass</a>;
<span class="returnvalue">Bonobo_Unknown</span>      (<a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimpleResolveFn" title="BonoboMonikerSimpleResolveFn ()">*BonoboMonikerSimpleResolveFn</a>)     (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="type">BonoboMoniker</span></a> *moniker</code></em>,
                                                         <em class="parameter"><code>const <span class="type">Bonobo_ResolveOptions</span> *options</code></em>,
                                                         <em class="parameter"><code>const <span class="type">CORBA_char</span> *requested_interface</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);
<a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="returnvalue">BonoboMoniker</span></a> *     <a class="link" href="libbonobo-bonobo-moniker-simple.html#bonobo-moniker-simple-construct" title="bonobo_moniker_simple_construct ()">bonobo_moniker_simple_construct</a>     (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple"><span class="type">BonoboMonikerSimple</span></a> *moniker</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *resolve_closure</code></em>);
<a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="returnvalue">BonoboMoniker</span></a> *     <a class="link" href="libbonobo-bonobo-moniker-simple.html#bonobo-moniker-simple-new" title="bonobo_moniker_simple_new ()">bonobo_moniker_simple_new</a>           (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimpleResolveFn" title="BonoboMonikerSimpleResolveFn ()"><span class="type">BonoboMonikerSimpleResolveFn</span></a> resolve_fn</code></em>);
<a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="returnvalue">BonoboMoniker</span></a> *     <a class="link" href="libbonobo-bonobo-moniker-simple.html#bonobo-moniker-simple-new-closure" title="bonobo_moniker_simple_new_closure ()">bonobo_moniker_simple_new_closure</a>   (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *resolve_closure</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-simple.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
         +----<a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker">BonoboMoniker</a>
               +----BonoboMonikerSimple
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-simple.description"></a><h2>Description</h2>
<p>
BonoboMonikerSimple makes writing monikers really extremely
easy. To implement a moniker you only have to write 1 function.
To register create the moniker object you have to use only 1
call. It can't get much simpler. If you want to use monikers
instead of implementing them, you probably want to see
<span class="type">bonobo-moniker-util</span> instead.
</p>
<p>
Few people need to implement monikers, but if they do, this
is how they should do it:
  </p>
<div class="example">
<a name="id3155283"></a><p class="title"><b>Example 15. A cut down file: moniker implementation</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="normal">Bonobo_Unknown</span>
<span class="function">bonobo_moniker_file_resolve</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">BonoboMoniker</span><span class="normal">               </span><span class="symbol">*</span><span class="normal">moniker</span><span class="symbol">,</span>
<span class="normal">                 </span><span class="keyword">const</span><span class="normal"> </span><span class="usertype">Bonobo_ResolveOptions</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">options</span><span class="symbol">,</span>
<span class="normal">                 </span><span class="keyword">const</span><span class="normal"> </span><span class="usertype">CORBA_char</span><span class="normal">            </span><span class="symbol">*</span><span class="normal">requested_interface</span><span class="symbol">,</span>
<span class="normal">                 </span><span class="usertype">CORBA_Environment</span><span class="normal">           </span><span class="symbol">*</span><span class="normal">ev</span><span class="symbol">)</span>
<span class="cbracket">{</span>
<span class="normal">    </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal">    </span><span class="symbol">*</span><span class="normal">fname </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="libbonobo-bonobo-moniker.html#bonobo-moniker-get-name">bonobo_moniker_get_name</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">moniker</span><span class="symbol">);</span>
<span class="normal">    </span><span class="usertype">Bonobo_Unknown</span><span class="normal"> retval</span><span class="symbol">;</span>
<span class="normal">    </span><span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Message-Logging.html#g-warning">g_warning</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Fname '%s'"</span><span class="symbol">,</span><span class="normal"> fname</span><span class="symbol">);</span>
<span class="normal">    </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(!</span><span class="function">strcmp</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">requested_interface</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"IDL:Bonobo/Stream:1.0"</span><span class="symbol">))</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal">        </span><span class="usertype">BonoboStream</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">stream</span><span class="symbol">;</span>
<span class="normal">        stream </span><span class="symbol">=</span><span class="normal"> </span><span class="function">bonobo_stream_open</span><span class="normal"> </span><span class="symbol">(</span><span class="string">"fs"</span><span class="symbol">,</span><span class="normal"> fname</span><span class="symbol">,</span>
<span class="normal">                         Bonobo_Storage_READ</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0664</span><span class="symbol">);</span>
<span class="normal">        </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(!</span><span class="normal">stream</span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal">            </span><span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Message-Logging.html#g-warning">g_warning</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Failed to open stream '%s'"</span><span class="symbol">,</span><span class="normal"> fname</span><span class="symbol">);</span>
<span class="normal">            </span><span class="function">CORBA_exception_set</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">ev</span><span class="symbol">,</span><span class="normal"> CORBA_USER_EXCEPTION</span><span class="symbol">,</span>
<span class="normal">                         ex_Bonobo_Moniker_InterfaceNotFound</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
<span class="normal">            </span><span class="keyword">return</span><span class="normal"> CORBA_OBJECT_NIL</span><span class="symbol">;</span>
<span class="normal">        </span><span class="cbracket">}</span>
<span class="normal">        </span><span class="keyword">return</span><span class="normal"> </span><span class="function">CORBA_Object_duplicate</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="libbonobo-bonobo-object.html#BONOBO-OBJREF:CAPS">BONOBO_OBJREF</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">stream</span><span class="symbol">),</span><span class="normal"> ev</span><span class="symbol">);</span>
<span class="normal">    </span><span class="cbracket">}</span>
<span class="normal">    </span><span class="keyword">return</span><span class="normal"> CORBA_OBJECT_NIL</span><span class="symbol">;</span>
<span class="cbracket">}</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<p><br class="example-break">
  After implementing the resolve function, you need to create the new moniker
in your standard factory:
  </p>
<div class="example">
<a name="id3155311"></a><p class="title"><b>Example 16. Creating a new simple moniker</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="keyword">static</span><span class="normal"> <a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a> </span><span class="symbol">*</span>
<span class="function">bonobo_std_moniker_factory</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">BonoboGenericFactory</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">this</span><span class="symbol">,</span>
<span class="normal">                </span><span class="keyword">const</span><span class="normal"> </span><span class="type">char</span><span class="normal">           </span><span class="symbol">*</span><span class="normal">object_id</span><span class="symbol">,</span>
<span class="normal">                </span><span class="type">void</span><span class="normal">                 </span><span class="symbol">*</span><span class="normal">data</span><span class="symbol">)</span>
<span class="cbracket">{</span>
<span class="normal">    </span><span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Warnings-and-Assertions.html#g-return-val-if-fail">g_return_val_if_fail</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">object_id </span><span class="symbol">!=</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
<span class="normal">    </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(!</span><span class="function">strcmp</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">object_id</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"OAFIID:Bonobo_Moniker_File"</span><span class="symbol">))</span>
<span class="normal">        </span><span class="keyword">return</span><span class="normal"> </span><span class="function">BONOBO_OBJECT</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="libbonobo-bonobo-moniker-simple.html#bonobo-moniker-simple-new">bonobo_moniker_simple_new</a></span><span class="normal"> </span><span class="symbol">(</span>
<span class="normal">            </span><span class="string">"file:"</span><span class="symbol">,</span><span class="normal"> bonobo_moniker_file_resolve</span><span class="symbol">));</span>
<span class="normal">    </span><span class="keyword">else</span>
<span class="normal">        </span><span class="keyword">return</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>
<span class="cbracket">}</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<p><br class="example-break">
</p>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-simple.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BonoboMonikerSimple-struct"></a><h3>BonoboMonikerSimple</h3>
<pre class="programlisting">typedef struct _BonoboMonikerSimple BonoboMonikerSimple;</pre>
<p>
A simplified <a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="type">BonoboMoniker</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboMonikerSimpleClass"></a><h3>BonoboMonikerSimpleClass</h3>
<pre class="programlisting">typedef struct {
	BonoboMonikerClass parent_class;
} BonoboMonikerSimpleClass;
</pre>
<p>
BonoboMonikerSimple's class.
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboMonikerSimpleResolveFn"></a><h3>BonoboMonikerSimpleResolveFn ()</h3>
<pre class="programlisting"><span class="returnvalue">Bonobo_Unknown</span>      (*BonoboMonikerSimpleResolveFn)     (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="type">BonoboMoniker</span></a> *moniker</code></em>,
                                                         <em class="parameter"><code>const <span class="type">Bonobo_ResolveOptions</span> *options</code></em>,
                                                         <em class="parameter"><code>const <span class="type">CORBA_char</span> *requested_interface</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);</pre>
<p>
Type of callback function that implements a simple moniker resolution.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>moniker</code></em> :</span></p></td>
<td>the moniker
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
<td>resolve options
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>requested_interface</code></em> :</span></p></td>
<td>the requested interface (repoid string)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ev</code></em> :</span></p></td>
<td>CORBA environment, in case an exception needs to be raised
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a Bonobo_Unknown as the result of the resolution
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-moniker-simple-construct"></a><h3>bonobo_moniker_simple_construct ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="returnvalue">BonoboMoniker</span></a> *     bonobo_moniker_simple_construct     (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple"><span class="type">BonoboMonikerSimple</span></a> *moniker</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *resolve_closure</code></em>);</pre>
<p>
Constructs a simple moniker
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>moniker</code></em> :</span></p></td>
<td>the moniker to construct
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name of the moniker eg. 'file:'
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>resolve_closure</code></em> :</span></p></td>
<td>the closure used to resolve the moniker
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the constructed moniker or NULL on failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-moniker-simple-new"></a><h3>bonobo_moniker_simple_new ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="returnvalue">BonoboMoniker</span></a> *     bonobo_moniker_simple_new           (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimpleResolveFn" title="BonoboMonikerSimpleResolveFn ()"><span class="type">BonoboMonikerSimpleResolveFn</span></a> resolve_fn</code></em>);</pre>
<p>
Create a new instance of a simplified moniker.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the display name for the moniker
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>resolve_fn</code></em> :</span></p></td>
<td>a resolve function for the moniker
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the moniker object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-moniker-simple-new-closure"></a><h3>bonobo_moniker_simple_new_closure ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="returnvalue">BonoboMoniker</span></a> *     bonobo_moniker_simple_new_closure   (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *resolve_closure</code></em>);</pre>
<p>
Create a new instance of a simplified moniker.
</p>
<p>
Instead of the Bonobo_ResolveOptions struct, the closure takes its
contents as two arguments: BONOBO_TYPE_RESOLVE_FLAG and G_TYPE_LONG.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the display name for the moniker
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>resolve_closure</code></em> :</span></p></td>
<td>a closure for the resolve process.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the moniker object
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-moniker-simple.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="libbonobo-bonobo-moniker.html#BonoboMoniker"><span class="type">BonoboMoniker</span></a>, <a class="link" href="libbonobo-bonobo-moniker-simple.html#BonoboMonikerSimple"><span class="type">BonoboMonikerSimple</span></a>, <span class="type">bonobo-moniker-util</span>, <a class="link" href="libbonobo-bonobo-moniker-extender.html#BonoboMonikerExtender"><span class="type">BonoboMonikerExtender</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15.1</div>
</body>
</html>